[feat] update README.md Rust Definition Package #141
+18
−7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicosammito
requested changes
Nov 15, 2025
README.md
Outdated
| ``` | ||
|
|
||
| ## Rust Definition Package | ||
| This package is a Rust crate designed to read and parse Code0 definition files (JSON) from a directory structure. It loads all features, including their data types, flow types, and runtime functions, providing them as idiomatic Rust structs. |
There was a problem hiding this comment.
Suggested change
| This package is a Rust crate designed to read and parse Code0 definition files (JSON) from a directory structure. It loads all features, including their data types, flow types, and runtime functions, providing them as idiomatic Rust structs. | |
| This package is a Rust crate designed to read and parse CodeZero definition files (JSON) from a directory structure. It loads all features, including data-types, flow-types, and runtime-functions, providing them as idiomatic Rust structs. |
README.md
Outdated
| This package is a Rust crate designed to read and parse Code0 definition files (JSON) from a directory structure. It loads all features, including their data types, flow types, and runtime functions, providing them as idiomatic Rust structs. | ||
|
|
||
| ### Package Resources | ||
| Create: [code0-definition-reader](https://crates.io/crates/code0-definition-reader) on crates.io |
nicosammito
approved these changes
Nov 16, 2025
raphael-goetz
requested changes
Nov 17, 2025
|
|
||
| ## Rust Definition Package | ||
|
|
||
| This package is a Rust crate designed to read and parse CodeZero definition files (JSON) from a directory structure. It loads all features, including data-types, flow-types, and runtime-functions, providing them as idiomatic Rust structs. |
Member
There was a problem hiding this comment.
Please describe the expected project structure!
| use code0_definition_reader::Definition; | ||
| use code0_definition_reader::Reader; | ||
|
|
||
| let reader = Reader::configure( |
Member
There was a problem hiding this comment.
Give examples and describe further what each parameter does!
| ); | ||
|
|
||
| let features = Definition::new("./path/to/definitions"); | ||
| let features = reader.read_features("./path/to/definitions"); |
Member
There was a problem hiding this comment.
I might overlooked this in the implementation of the reader but you have already given the reader the path with the constructor. Why then providing the path again if you have already access to the path with self.path?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: #136